home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 21 / Cream of the Crop 21 (Terry Blount) (October 1996).iso / windows / yawpi22.zip / YAWPI.TXT < prev   
Text File  |  1996-07-09  |  31KB  |  974 lines
  1.                  YAWPI: Yet Another Windows Program Installer
  2.                  ============================================
  3.  
  4.                                 Version 2.2
  5.                                 ===========
  6.  
  7.  
  8. 1. Introduction
  9. _______________
  10.  
  11. YAWPI is a simple yet powerful and elegant Windows installation program.
  12. It features user selection of destination directory full screen main window
  13. with color gradient (similar to MS-Setup) and display of meter bar
  14. (progress bar) for each program disk as well as numeric percentage progress
  15. per file or archive.
  16.  
  17. New in version 2.2 are copy directories, prompt before exec and placement
  18. of the title line at the bottom of the screen.
  19.  
  20. New in version 2.1 are uninstall, support for multiple languages and a few
  21. other enhancements.
  22.  
  23. YAWPI can copy files and uncompress archives (as well as nested archives)
  24. into subdirectories or the Windows directory. The decompression code is
  25. integrated in INSTALL.EXE. That means that you can compress your application
  26. very tightly without paying royalties for compression software.
  27.  
  28. The source directory can be on a floppy drive, CD drive or hard drive.
  29. Multiple floppy diskettes are supported, as well as multiple .zip files
  30. distributed through BBS's and the Internet.
  31.  
  32. The installation parameters are set by defining variables in a simple syntax
  33. similar to .INI files (Variable=Value). No scripts and no fancy script
  34. editors and generators - simply edit a few short text files - that's all
  35. there is to it!! If you start from the supplied samples you can have a
  36. complete package in half an hour.
  37.  
  38.  
  39. 2. Registration
  40. _______________
  41.  
  42. YAWPI is a shareware product. It means that you must register before
  43. using this software to distribute your application.
  44.  
  45. The unregistered version has all the functionally of the registered version
  46. so you can prepare your configuration files and test the installation
  47. process before registering. However, the unregistered version displays
  48. the message "YAWPI - Unregistered Version" on the caption bar.
  49.  
  50. With QUICK registration you simply receive a registration password that
  51. matches your name (or company name). As soon as you enter your name and
  52. password to the 'Register' dialog of the Seal editor, you can modify the
  53. title of the caption bar to match your application.
  54.  
  55. Your password will work with future versions of YAWPI, so you can upgrade
  56. by simply downloading the latest version from our home page
  57. (http://www.rtlsoft.com/yawpi) or from any other location.
  58.  
  59. With FULL registration you will receive the full source code (C and C++)
  60. of YAWPI and AR, so you will be free to further fine tune it according
  61. to your needs.
  62.  
  63. Edit the file "register.txt" (or click on the "Register" icon), fill in
  64. the details and send it with your payment by e-mail, fax or s-mail.
  65.  
  66. 3. Windows 95
  67. _____________
  68.  
  69. This version of YAWPI was compiled for Windows 3.1 but was tested under
  70. Windows 95. It works well under Windows 95 but does not support long file
  71. names or long directory names (folders, that is...).
  72.  
  73. INSTALL.EXE may be renamed to SETUP.EXE (or anything else, for example
  74. CdSetup.exe and HdSetup.exe).
  75.  
  76.  
  77. 4. Compressed Archives
  78. ______________________
  79.  
  80. YAWPI supports archives compressed by the AR freeware utility. AR is not
  81. compatible with PKZIP but achieves almost the same compression rate.
  82. This is *far* better than using Microsoft COMPRESS on individual files.
  83.  
  84. AR is freeware and is available with C source. The DOS based AR.EXE
  85. is included in this package.
  86.  
  87. If your application uses a large number of small files you can save upto 15%
  88. of the space by using nested archives. The extra saving comes from the fact
  89. that compression algorithms work better on large files. You first combine
  90. your small files into one large *uncompressed* archive, then compress
  91. that file into a container archive. Here is how you do it with AR:
  92.  
  93.     AR s myprog.ar files*.*
  94.     AR a myprog.arr myprog.ar
  95.  
  96. "myprog.arr" is smaller than "myprog.ar" created by:
  97.  
  98.     AR a myprog.ar files*.*
  99.  
  100. If you mark "myprog.arr" as a nested archive, YAWPI will perform
  101. the following steps during installation:
  102.  
  103.         1. Extract "myprog.ar" from "myprog.arr".
  104.         2. Extract "files*.*" from "myprog.ar".
  105.         3. Delete "myprog.ar".
  106.  
  107. Notes:
  108.  
  109.         1. AR always saves and restores the file paths in the archive. This
  110.            is equivalent to "pkzip -P" and "pkunzip -d". 
  111.  
  112.            You should therefore avoid specifying absolute pathnames when 
  113.            preparing the archives.
  114.  
  115.                          ar myprog.ar c:\myprog\files*.*
  116.            ar mydata.ar c:\myprog\data\files*.*
  117.  
  118.        Wrong:  paths are absolute, user cannot change them.
  119.  
  120.                    cd \myprog 
  121.            ar myprog.ar files*.*
  122.                    ar mydata.ar data\files*.*
  123.  
  124.            Right:  paths are relative to c:\myprog, user can install
  125.                    to another directory such as d:\userprog.
  126.                    
  127.         2. To create a nested archive with pkzip use the following steps:
  128.  
  129.            pkzip -e0 myprog0.zip files*.*
  130.            pkzip myprog.zip myprog0.zip
  131.  
  132.  
  133. 5. INSTALL.CFG
  134. ______________
  135.  
  136. The "install.cfg" file contains three sections:
  137.  
  138.     1. General section [General] contains general parameters.
  139.     2. Disk section [Disk1] [Disk2] etc. contains the list of files and 
  140.        archives to be installed.
  141.     3. Groups section [Groups] contains the program group and icons to
  142.        be installed on the user's desktop.
  143.  
  144. This file must be located on the first floppy disk (or in a subdirectory of
  145. the hard drive) together with "install.exe".
  146.  
  147. If you rename "install.exe" to another name, you must also rename "install.cfg".
  148.  
  149. For example, your CD-ROM application may include "CdSetup.exe" and "HdSetup.exe"
  150. for running directly from the CD drive or from the hard drive, respectively. 
  151. In that case, include "CdSetup.cfg" and "HdSetup.cfg" files to provide the
  152. configuration for each type of installation.
  153.  
  154. The following subsections (numbered 5.*) describe the variables that belong 
  155. to the general section of "install.cfg".
  156.  
  157.  
  158. 5.1 ProgramName
  159.  
  160. Defines the name of the program being installed.
  161.  
  162. Example: ProgramName=Magic Graphics
  163.  
  164.  
  165. 5.2 DefaultPath
  166.  
  167. Defines the default destination path for installing the program.
  168.  
  169. Example: DefaultPath=C:\MGRAPHIC
  170.  
  171. 5.2a DestPathPrompt
  172.  
  173. If defined to "N" the user is not prompted for destination path.
  174. By default DestPathPrompt is "Y".
  175.  
  176. Example:
  177.  
  178. DestPathPrompt=N
  179.  
  180. Note that DefaultPath must be specified, even if no files are copied.
  181.  
  182. 5.3 Title1
  183.  
  184. A centered title line at the top of the main window.
  185.  
  186. Example: Title1=Magic Graphics
  187.  
  188. 5.4 Title1Size
  189.  
  190. Size of Title1 in points. This number is converted to pixels depending on
  191. the screen resolution. Use 50 points for large letters, 20 points for small
  192. letters, or any number in between.
  193.  
  194. Example: Title1Size=25
  195.  
  196. 5.5 Title1Color
  197.  
  198. Color of Title1 in RGB.
  199.  
  200. Example: Title1Color=30 187 0
  201.  
  202.  
  203. 5.6 Title2, Title2Size, Title2Color
  204.  
  205. Same as Title1. This is a second title line.
  206.  
  207. 5.6a Title2Pos
  208.  
  209. By default Title2 is drawn just below Title1 at the top of the screen.
  210. If you define
  211.  
  212. Title2Pos=Bottom
  213.  
  214. then Title2 is drawn at the bottom of the screen.
  215.  
  216. 5.7 TitleFont
  217.  
  218. The font used for both titles. The default font is "Times New Roman".
  219. However, if you specify a font which does not exist on the user's
  220. system, Windows uses its default font of "Arial".
  221.  
  222. 5.8 TitleShadeColor
  223.  
  224. Color of shade for Title1 and Title2 in RGB.
  225.  
  226. Example: TitleShadeColor=0 0 0
  227.  
  228. 5.9 TopColor, BottomColor
  229.  
  230. Define the background color at the top and bottom of the main window.
  231. You can get a solid background by setting TopColor and BottomColor to the
  232. same value. If TopColor is different than Bottom Color you get
  233. a color gradient.
  234.  
  235. Example:
  236.  
  237.           TopColor=0 76 38
  238.         BottomColor=51 204 102
  239.  
  240. 5.10 NumGradientSteps
  241.  
  242. Defines the number of color gradient steps. This number should not
  243. exceed 200.
  244.  
  245. Example: NumGradientSteps=32
  246.  
  247. 5.11 Welcome, WelcomeCaption
  248.  
  249. If "Welcome" is defined, a dialog box with this message and "Yes/No"
  250. buttons is dis